home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 4 / Amiga Tools 4.iso / tools / dfue / term / documentation / xpr_libs / xprascii.doc < prev    next >
Encoding:
Text File  |  1993-01-03  |  5.2 KB  |  163 lines
  1. xprascii.library -- version 2.3
  2.  
  3.  
  4. This is an XPR 2.0 implementation of the ASCII protocol.
  5.  
  6. based on xprascii.library 0.9 by W.G.J. Langeveld
  7.  
  8. Source code modifications and additions needed for XPR are:
  9.  
  10.     Copyright ©1992 Ueli Kaufmann, All Rights Reserved.
  11.  
  12. This software is provided "AS IS" without warranty of any kind, either
  13. expressed or implied, with respect to the programs described herein, their
  14. quality, performance, or fitness for any particular purpose.
  15.  
  16. In no event will the author(s) be liable for direct, indirect, incidental,
  17. or consequential damages.
  18.  
  19. redistribution of this software is permitted, provided that:
  20.  
  21.     1. all files are included, and in their original form.
  22.     2. if included with a particular product (commercial or
  23.        otherwise), proper credit is given to the authors in that
  24.        product's documentation.
  25.  
  26. By using or distributing this software, you agree to understand and accept
  27. the above.
  28.  
  29.  
  30.  
  31. There's nothing really fancy about it..(-:
  32.  
  33. Configurable options are:
  34.  `char delay'
  35.  `line delay'
  36.  `line-feed translation',
  37.  `carriage-return translation',
  38.  `uuencode/uudecode files'
  39.  `delete received uudecoded files'
  40.  `expand blank lines',
  41.  `prompt char'
  42.  `strip high bit'
  43.  
  44.  
  45. (C)har delay:  C<ticks>
  46. -------------
  47. A numeric value in ticks (1 tick = 20msecs) which causes XPr-ASCII
  48. to wait (also called "pacing") before transmitting each character. 
  49. Values between zero and 500 (10 secs) are valid.
  50. (default: 0).
  51.  
  52.  
  53. (L)ine delay:  L<ticks>
  54. -------------
  55. Milliseconds to wait between the transmission of each line
  56. of text.  The same limits of the character delay option
  57. described in the previous section apply here.
  58. (default: 0)
  59.  
  60.  
  61. Carriage-(R)eturn translation:   R<n|s|x|a>
  62. ------------------------------
  63. The three options available determine how an incoming carriage
  64. return is to be handled.  You can either do nothing via the
  65. (N)one option, (S)trip it, e(X)change for a linefeed <LF>,
  66. or (A)dd a linefeed <LF> character to it.
  67. (default: "None")
  68.  
  69.  
  70. Line-(F)eed translation:   F<n|s|x|a>
  71. ------------------------
  72. Like the CR transl. feature described in the paragraph above, you
  73. can also select how an incoming linefeed <LF> character is to be
  74. translated.  As above, you can leave it alone (None), (S)trip it,
  75. e(X)change for a <CR> or (A)dd a carriage return <CR> character to it.
  76. (default: "None")
  77.  
  78.  
  79. (U)uencode/decode file when sending/receiving:   U<0|1>
  80. ----------------------------------------------
  81. XPr-Ascii gives you the chance to uuencode binary-files `on the fly'
  82. when they are sent. It's possible to uudecode files after receiving, too.
  83. (default: off)
  84.  
  85. * `forwarded' from UUCode.doc/UU3722.lha    by Klaus Alexander Seistrup
  86. *
  87. *   FUNCTION
  88. *       These programs/functions are primarily for use with electronic
  89. *       mail systems such as FidoNet and UUCP.
  90. *
  91. *       UUEncode sort of encrypts a program so that the output will only
  92. *       contain printable characters, thus allowing you to post a binary
  93. *       file in a message area.
  94. *
  95. *       UUDecode does the opposite thing: it decrypts an UUEncode'd ASCII
  96. *       file into its binary origin. It is *NOT* necessary to cut out the
  97. *       UUEncode'd part of a message in order to decode it - just pass the
  98. *       whole msg to UUDecode.
  99. *
  100. *       Please note that UUEncode doesn't perform any kind of compression!
  101. *       In fact, any UUEncode'd file will be *at least* one third bigger
  102. *       than the original file, due to the loss of information by convert-
  103. *       ing the file to ASCII.
  104. *
  105. *       Please also note that not all moderators welcome UUEncode't files
  106. *       and remember that a lot of people will be paying money for down-
  107. *       loading your messages - so use it with care, huh? :-)
  108. *       The encode file has an ordinary text form and can be  edited
  109. *       by any text editor to change the mode or remote name.
  110. *
  111. *       This version of uuencode  automatically  adds  checksums  to
  112. *       each  line,  and  an overall file size to the end.  Old ver-
  113. *       sions of uudecode will ignore this  extra  information,  new
  114. *       versions will check it and complain if it is in error.
  115.  
  116.  
  117.  
  118. (D)elete uudecoded file:   D<0|1>
  119. ------------------------
  120. Delete received uuencoded ascii-file after uudecoding.
  121. (default: off)
  122.  
  123.  
  124. (S)trip high bit:   S<0|1>
  125. -----------------
  126. Use this option if you want the high bit of each character
  127. reset that is received when using 8N1.
  128. (default: off)
  129.  
  130.  
  131. (E)xpand blanks:    E<0|1>
  132. ----------------
  133. When this feature is selected, XPr-ASCII will send one space
  134. character for lines which contain only an end-of-line
  135. character.  Use this option when the on-line text editor
  136. you're using exits its input mode whenever a carriage return
  137. is received without any text preceding it.
  138. (default: on).
  139.  
  140.  
  141. (P)rompt char:    P<char>
  142. --------------
  143. Instructs XPr-ASCII to wait for a specific character after
  144. transmitting a line of text.  If blank, text is sent continuously
  145. without interruption for the duration of the transfer.
  146. special chars are:
  147.  \0    = null   (prompt-char option is disabled)
  148.  \n    = newline         (ASCII 10)
  149.  \r    = carriage return (ASCII 13)
  150.  \\    = backslash       (ASCII 47)
  151.  \dNNN = Any decimal ASCII-value  fe: \27  Escape (ASCII 27)
  152. (default: null {=\0}).
  153.  
  154.  
  155.  
  156.  
  157. Send bug-reps, gifts, flames etc. to:
  158.  
  159. Ueli Kaufmann
  160. uucp:  Ueli_Kaufmann@augs1.adsp.sub.org
  161. znet:  U.KAUFMANN@LINK-CH1.ZER
  162. fido:  2:802/810.0 Ueli Kaufmann
  163.